Rescind policy that commits should start with "[skip changelog]" #201
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The raw release changelog is generated from the commit messages. The `arduino/create-changelog` action is configured to omit any commit message that is prefixed with "[skip changelog]". After extensive use of this approach in the Arduino CLI repository, my conclusion is that it provides a miniscule time savings for the release manager at the cost of massive pollution of the valuable commit history and a significantly less contributor friendly repository. For this reason, I have never employed this practice in my work on Arduino Lint and I do not want contributors to do so either.
per1234
added
topic: documentation
|
Mmmmh, fair enough. To tell you the thruth it doesn't help that much on the CLI either, when releasing a new version I still edit the generated changelog manually to enhance the formatting and delete those commits that don't introduce meaningful changes. Should we change the policy on the CLI docs too? |
silvanocerza
approved these changes
Jul 2, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The raw release changelog is generated from the commit messages. The
arduino/create-changelogaction is configured toomit any commit message that is prefixed with "[skip changelog]".
After extensive use of this approach in the Arduino CLI repository, my conclusion is that it provides a miniscule time
savings for the release manager at the cost of massive pollution of the valuable commit history and a significantly less
contributor friendly repository. For this reason, I have never employed this practice in my work on Arduino Lint and I do
not want contributors to do so either.